home *** CD-ROM | disk | FTP | other *** search
/ SGI Freeware 1999 August / SGI Freeware 1999 August.iso / dist / fw_xemacs.idb / usr / freeware / lib / xemacs-20.4 / lisp / auctex / README.z / README (.txt)
Encoding:
LaTeX Document  |  1998-05-21  |  6.8 KB  |  132 lines
  1. Introduction to AUC TeX
  2. ***********************
  3. This section of the AUC TeX manual gives a brief overview of what AUC
  4. TeX is, and the section is also available as a `README' file.  It is
  5. *not* an attempt to document AUC TeX.  Real documentation for AUC TeX
  6. is available in the rest of the manual, which you can find in the `doc'
  7. directory.
  8.    Read the `INSTALLATION' file for information about how to install
  9. AUC TeX.  It is identical to the Installation chapter in the AUC TeX
  10. manual.
  11.    If you are upgrading from the previous version of AUC TeX, the
  12. latest changes can be found in the `CHANGES' file.  If you are
  13. upgrading from an older version, read the History chapter in the AUC
  14. TeX manual.
  15.    AUC TeX is a comprehensive customizable integrated environment for
  16. writing input files for LaTeX using GNU Emacs.
  17.    AUC TeX lets you run TeX/LaTeX and other LaTeX-related tools, such
  18. as a output filters or post processor from inside Emacs.  Especially
  19. `running LaTeX' is interesting, as AUC TeX lets you browse through the
  20. errors TeX reported, while it moves the cursor directly to the reported
  21. error, and displays some documentation for that particular error.  This
  22. will even work when the document is spread over several files.
  23.    AUC TeX automatically indents your `LaTeX-source', not only as you
  24. write it -- you can also let it indent and format an entire document.
  25. It has a special outline feature, which can greatly help you `getting an
  26. overview' of a document.
  27.    Apart from these special features, AUC TeX provides an large range of
  28. handy Emacs macros, which in several different ways can help you write
  29. your LaTeX documents fast and painless.
  30.    All features of AUC TeX are documented using the GNU Emacs online
  31. documentation system.  That is, documentation for any command is just a
  32. key click away!
  33.    AUC TeX is written entirely in Emacs-Lisp, and hence you can easily
  34. add new features for your own needs.  It was not made as part of any
  35. particular employment or project (apart from the AUC TeX project
  36. itself).  AUC TeX is distributed under the `GNU Emacs General Public
  37. License' and may therefore almost freely be copied and redistributed.
  38.    The next sections are a short introduction to some `actual' features.
  39. For further information, refer to the build-in online documentation of
  40. AUC TeX.
  41. Indentation and formatting
  42. ==========================
  43.    AUC TeX may automatically indent your document as you write it. By
  44. pressing lfd instead of ret at the end of a line, the current line is
  45. indented by two spaces according to the current environment level, and
  46. the cursor is moved down one line.  By pressing tab, the current line
  47. is indented, and the cursor stays where it is.  The well-known Emacs
  48. feature `format-paragraph' (`M-q') is reimplemented especially for AUC
  49. TeX to follow the indentation.  A special command `LaTeX-fill-buffer'
  50. lets you indent an entire document like the well-known C utility indent
  51. (this time, only according to the LaTeX structure :-).
  52. Completion
  53. ==========
  54.    By studying your `\documentstyle' command (in the top of your
  55. document), and consulting a precompiled list of (La)TeX symbols from a
  56. large number of TeX and LaTeX files, AUC TeX is aware of the LaTeX
  57. commands you should able to use in this particular document.  This
  58. `knowledge' of AUC TeX is used for two purposes.
  59.   1. To make you able to `complete' partly written LaTeX commands. You
  60.      may e.g. write `\renew' and press `M-tab' (`TeX-complete-symbol'),
  61.      and then AUC TeX will complete the word `\renewcommand' for you.
  62.      In case of ambiguity it will display a list of possible
  63.      completions.
  64.   2. To aid you inserting environments, that is \begin - \end pairs.
  65.      This is done by pressing C-c C-e (LaTeX-environment), and you will
  66.      be prompted for which `environment' to insert.
  67. Editing your document
  68. =====================
  69.    A number of more or less intelligent keyboard macros have been
  70. defined to aid you editing your document.  The most important are
  71. listed here below.
  72. `LaTeX-environment'
  73.      (`C-c C-e') Insert a `\begin{}' -- `\end{}' pair as described
  74.      above.
  75. `LaTeX-section'
  76.      (`C-c C-s') Insert one of `\chapter', `\section', etc.
  77. `TeX-font'
  78.      (`C-c C-f C-r', `C-c C-f C-i', `C-c C-f C-b') Insert one of
  79.      `{\textrm }'), `{\textit \/}' `{\textbf }' etc.
  80.    A number of additional functions are available.  But it would be far
  81. too much to write about here.  Refer to the rest of the AUC TeX
  82. documentation for further information.
  83. Running LaTeX
  84. =============
  85.    When invoking on of the commands `TeX-command-master' (`C-c C-c') or
  86. `TeX-command-region' (`C-c C-r') LaTeX is run on either the entire
  87. current document or a given region of it.  The Emacs view is split in
  88. two, and the output of TeX is printed in the second half of the screen,
  89. as you may simultaneously continue editing your document.  In case TeX
  90. found any errors when processing your input you can call the function
  91. `TeX-next-error' (`C-c `') which will move the cursor to the first
  92. given error, and display a short explanatory text along with the
  93. message TeX gave.  This procedure may be repeated until all errors have
  94. been displayed.  By pressing `C-c C-w' (`TeX-toggle-debug-boxes') you
  95. can toggle whether the browser also should notify over-full/under-full
  96. boxes or not.
  97.    Once you've successfully formatted your document, you may preview or
  98. print it by invoking `TeX-command-master' again.
  99. Outlines
  100. ========
  101.    Along with AUC TeX comes support for outline mode for Emacs, which
  102. lets you browse the sectioning structure of your document, while you
  103. will still be able to use the full power of the rest of the AUC TeX
  104. functionality.
  105. Availability
  106. ============
  107.    The most recent version is always available by ftp at
  108.                    `ftp://ftp.iesd.auc.dk/pub/emacs-lisp/auctex.tar.gz'
  109.    In case you don't have access anonymous ftp, you can get it by email
  110. requests to `<ftpmail@decwrl.dec.com>'.
  111.    WWW users may want to check out the AUC TeX page at
  112.                                `http://www.iesd.auc.dk/~amanda/auctex/'
  113. Contacts
  114. ========
  115.    There has been established a mailing list for help, bug reports,
  116. feature requests and general discussion about AUC TeX.  You're very
  117. welcome to join.  Traffic average at an article by day, but they come
  118. in bursts.  If you are only interested in information on updates, you
  119. could refer to the newsgroups `comp.text.tex' and `gnu.emacs.sources'.
  120.    If you want to contact the AUC TeX mailing list, send mail to
  121. `<auc-tex-request@iesd.auc.dk>' in order to join.  Articles should be
  122. send to `<auc-tex@iesd.auc.dk>'.
  123.    To contact the current maintainers of auc-TeX directly, email
  124. `<auc-tex_mgr@iesd.auc.dk>'.
  125.              AUC TeX development
  126.              c/o Kresten Krab Thorup
  127.      
  128.              Mathematics and Computer Science
  129.              University of Aalborg
  130.              DK 9000 Aalborg
  131.              Denmark
  132.